-
Notifications
You must be signed in to change notification settings - Fork 4
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
docs: add quartodoc website for documentation #197
Conversation
☂️ Python Coverage
Overall Coverage
New FilesNo new covered files... Modified Files
|
e7aefc5
to
bd23d53
Compare
The docs site is far from perfect, but this at least gets things moving. |
Thanks for taking this on. There's lots to improve here, but we can tackle that as we go. Might be good to bring in Greg or others that worked on Shiny's docs recently, their site looks nice and I notice they have some custom code to handle some formatting. The one thing I'd like to see if we could solve from the beginning is the URL structure. Instead of /reference/connect.bundles.html etc., could we make that be /reference/connect/bundles.html, i.e. have the |
Not that I have found. These URLs are configured by Quartodoc, and I do not see a way to force them to this style. @machow - do you know if this is possible? |
We should be using the Posit Theme instead of the default cosmo - https://github.com/posit-dev/product-doc-theme?tab=readme-ov-file#product-doc-theme |
Thanks! I'll add that. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for getting the theme added! I think it still needs some tweaking - there's missing Footer info that has content required by Marketing/Legal. Ashley or I can poke at it if you have trouble, just let me know!
docs/installation.qmd
Outdated
|
||
- [Requests](https://requests.readthedocs.io/en/latest/) provides the HTTP layer. | ||
|
||
# Install Posit's SDK |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
# Install Posit's SDK | |
# Install the Posit SDK |
Thanks for the review! I ran into issues installing the theme as instructed within the Makefile. As you can see in the _quarto.yaml, I ended up directly importing the assets to get around this. I'll look into adding the footer. |
Co-authored-by: annikakrilov <[email protected]>
Will address subsequent issues in follow up. |
Adds a documentation site using Quartodoc. Various changes are introduced to the docstrings in order to accommodate Quartodoc nuances.
Resolves #196
Do the following to preview.
Do the following to build from root, assuming deps and dev or build are ran prior.
Now that a base is established, I will do smaller PRs for incremental changes.